Get detailed information for a specific user.

12 May 2026
8 Minutes to read
Contributors

Print
Share
Dark
Light

Get detailed information for a specific user.

Updated on 12 May 2026
8 Minutes to read
Contributors

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Get

/v3/projects/{project_id}/users/{user_id}

Returns the complete user profile including portal role, content roles with access scope levels, and associated group memberships. Returns 404 Not Found if the user does not exist in the project. To retrieve a user ID, call GET /v3/projects/{projectId}/users first. For the currently authenticated user, prefer GET /v3/projects/{projectId}/users/me instead.

Security

OAuth

All V3 endpoints require a Bearer token. Generate tokens in the Document360 portal under Settings > API Tokens. Tokens are project-scoped, require the customerApi scope, and do not expire by default. Tokens can be revoked at any time from the portal. Include the token in every request: Authorization: Bearer <your-token>. Alternatively, use the Authorize button below to sign in via OAuth2 Authorization Code flow with PKCE.

FlowAuthorization Code

Authorization URLhttps://identity.document360.net/connect/authorize

Token URLhttps://identity.document360.net/connect/token

Scopes:

customerApiDocument360 Customer API

Path parameters

project_id

string (uuid) Required

The unique identifier of the project. Retrieve project IDs from GET /v3/projects.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

user_id

string (uuid) Required

The identifier of the user to retrieve. Retrieve user IDs from GET /v3/projects/{projectId}/users.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

Responses

200

User detail retrieved successfully.

Single user details

Returns the full details of a specific user

{
  "data": {
    "id": "4a9b0c1d-e2f3-4a4b-c5d6-e7f8a9b0c1d2",
    "first_name": "James",
    "last_name": "Patel",
    "email": "[email protected]",
    "profile_logo_url": "https://cdn.document360.io/avatars/4a9b0c1d.png",
    "created_at": null,
    "last_login_at": "2025-06-18T09:15:00Z",
    "portal_role": {
      "id": "d6e7f8a9-b0c1-4d2e-f3a4-b5c6d7e8f9a0",
      "name": "Admin"
    },
    "content_roles": [
      {
        "id": "f2a3b4c5-d6e7-4f8a-b9c0-d1e2f3a4b5c6",
        "name": "Editor",
        "access_scope_level": "project"
      },
      {
        "id": "a7b8c9d0-e1f2-4a3b-c4d5-e6f7a8b9c0d1",
        "name": "Reviewer",
        "access_scope_level": "category"
      }
    ],
    "associated_groups": [
      {
        "id": "a4b5c6d7-e8f9-4a0b-c1d2-e3f4a5b6c7d8",
        "title": "Documentation Team",
        "description": "Core documentation writers and editors"
      },
      {
        "id": "b5c6d7e8-f9a0-4b1c-d2e3-f4a5b6c7d8e9",
        "title": "API Documentation",
        "description": "Team responsible for API reference docs"
      }
    ]
  },
  "success": true,
  "request_id": "c3d4e5f6-a7b8-9012-cdef-a23456789012",
  "errors": [],
  "warnings": []
}

Expand All

object

Generic API response wrapper containing typed data.

data

object

Response data payload.

string (uuid) | null

Unique identifier of the user.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

first_name

string | null

First name of the user.

last_name

string | null

Last name of the user.

string (email) | null

Email address of the user.

Example[email protected]

profile_logo_url

string | null

URL to the user's profile avatar image.

created_at

string (date-time) | null

Date and time when the user account was created.

last_login_at

string (date-time) | null

Date and time when the user last logged in. Null if the user has never logged in.

portal_role

object | null

The portal-level role assigned to this user, controlling access to project settings and administration.

string (uuid) | null

Unique identifier of the role.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

name

string | null

Display name of the role.

ExampleAdmin

content_roles

Array of object (ContentRoleSummary) | null

List of content-level roles assigned to this user, controlling what content they can create and edit.

object

Summary of a content role assignment including the access scope level.

string (uuid) | null

Unique identifier of the content role.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

name

string | null

Display name of the content role.

ExampleEditor

access_scope_level

string

The level at which this content role's access is scoped. Possible values: 0 = None, 1 = Category, 2 = Version, 3 = Project, 4 = Language, 5 = Article, 6 = Workspace.

Valid values[ "none", "category", "version", "project", "language", "article", "workspace" ]

associated_groups

Array of object (UserGroupInfo) | null

User groups that this user belongs to.

object

Basic information about a user group that a user belongs to.

string (uuid) | null

Unique identifier of the user group.

Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d

title

string | null

Display name of the user group.

ExampleDocumentation Team

description

string | null

Description of the user group's purpose.

success

boolean

Whether the API request was successful.

request_id

string

Unique identifier for request tracing and correlation.

Min length1

errors

Array of object (ApiError) | null

List of errors if the request failed.

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

List of non-fatal warnings from the request.

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

401

Authentication token is missing or invalid.

Headers

WWW-Authenticate

string

Indicates the authentication scheme required. Returns `Bearer` with optional `error` and `error_description` parameters per RFC 6750.

Missing or invalid token

Authentication token is missing or invalid.

{
  "type": "https://developer.document360.com/errors/unauthorized",
  "title": "Unauthorized.",
  "status": 401,
  "detail": "The authentication token is missing or has expired.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Bearer token is missing or invalid.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type

string

URI reference identifying the error type (links to documentation).

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

404

User not found.

Resource not found

The requested resource was not found.

{
  "type": "https://developer.document360.com/errors/not-found",
  "title": "Not Found.",
  "status": 404,
  "detail": "The requested resource does not exist or has been deleted.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "RESOURCE_NOT_FOUND",
      "message": "The requested resource was not found.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type

string

URI reference identifying the error type (links to documentation).

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

429

Rate limit exceeded. Retry after the duration specified in the Retry-After header.

Headers

Retry-After

integer

Number of seconds to wait before retrying the request. Use exponential backoff with jitter for optimal retry behavior.

X-RateLimit-Limit

integer

The maximum number of requests allowed in the current time window. Limits are applied per API token per project.

X-RateLimit-Remaining

integer

The number of requests remaining in the current time window. When this reaches 0, subsequent requests will receive a 429 response.

X-RateLimit-Reset

integer

The UTC epoch timestamp (in seconds) when the current rate limit window resets.

Rate limit exceeded

Rate limit exceeded.

{
  "type": "https://developer.document360.com/errors/too-many-requests",
  "title": "Too Many Requests.",
  "status": 429,
  "detail": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "message": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type

string

URI reference identifying the error type (links to documentation).

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

500

An unexpected server error occurred.

Unexpected server error

Unexpected server error.

{
  "type": "https://developer.document360.com/errors/internal-error",
  "title": "Internal Server Error.",
  "status": 500,
  "detail": "An unexpected error occurred. Please try again or contact support.",
  "instance": null,
  "trace_id": "req_abc123def456",
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "message": "An unexpected error occurred.",
      "field": null,
      "details": null
    }
  ],
  "warnings": null
}

Expand All

object

RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json

type

string

URI reference identifying the error type (links to documentation).

Min length1

title

string

Short human-readable summary of the error type.

Min length1

status

integer (int32)

HTTP status code.

detail

string | null

Human-readable explanation specific to this occurrence.

instance

string | null

URI of the request that generated the error.

trace_id

string | null

Request trace identifier for correlation.

errors

Array of object (ApiError) | null

Structured list of specific errors (extension field).

object

Represents an error returned by the API.

code

string

Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).

Min length1

message

string

Human-readable error message.

Min length1

field

string | null

The request field that caused the error, if applicable.

details

string | null

Additional context about the error.

warnings

Array of object (ApiWarning) | null

Non-fatal warnings (extension field).

object

Represents a non-fatal warning from the API.

code

string

Machine-readable warning code.

Min length1

message

string

Human-readable warning message.

Min length1

Was this article helpful?

What's Next

Get the currently authenticated user's details.